<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>src.processing.processor</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="src-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >ttrq4fleet - Petrina Papazek</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="src-module.html">Package&nbsp;src</a> ::
        <a href="src.processing-module.html">Package&nbsp;processing</a> ::
        Module&nbsp;processor
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="src.processing.processor-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="src.processing.processor-module.html">Module src.processing.processor</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-docstring">Created on Aug 13, 2012</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-docstring">@author: petrina</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line">  </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">logging</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"> </tt>
<a name="Processor"></a><div id="Processor-def"><a name="L9"></a><tt class="py-lineno"> 9</tt> <a class="py-toggle" href="#" id="Processor-toggle" onclick="return toggle('Processor');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="src.processing.processor.Processor-class.html">Processor</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Processor-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="Processor-expanded"><a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line">    <tt class="py-docstring">'''</tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-docstring">    This class manages the processing (i.e. calculation of indicators).</tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-docstring">    Therefore it takes the indicator-configuration, inits and sets up the indicator_list.</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-docstring">    It offers methods for calculating the indicators (if indiconf is None all </tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">    indicators are calculated).</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring">    '''</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line"> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"> </tt>
<a name="Processor.__init__"></a><div id="Processor.__init__-def"><a name="L19"></a><tt class="py-lineno">19</tt> <a class="py-toggle" href="#" id="Processor.__init__-toggle" onclick="return toggle('Processor.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="src.processing.processor.Processor-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">indiset</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Processor.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="Processor.__init__-expanded"><a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line">        <tt class="py-docstring">'''</tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line"><tt class="py-docstring">        The constructor builds indicator-list using the given link object.</tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line"><tt class="py-docstring">        The calculation of the indicators is not started. </tt> </tt>
<a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line"><tt class="py-docstring">        The method calculate_indicators() is responsible for the calculations.</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line"><tt class="py-docstring">        The indiconf will be passed to the set of indicators.</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line"><tt class="py-docstring">        @param indiconf: the Indicator-configuration is a list containing the indicators-abbreviations or None (= all indicators, default) </tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">         </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_indiset</tt> <tt class="py-op">=</tt> <tt class="py-name">indiset</tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line">        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Method src.processing.processor.Processor.calculate_indicators()=src.processing.processor.Processor-class.html#calculate_indicators"><a title="src.processing.processor.Processor.calculate_indicators" class="py-name" href="#" onclick="return doclink('link-0', 'calculate_indicators', 'link-0');">calculate_indicators</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line">             </tt>
<a name="L33"></a><tt class="py-lineno">33</tt>  <tt class="py-line">        <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">debug</tt><tt class="py-op">(</tt><tt class="py-string">"Processor: created Processor"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line">         </tt>
<a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line">         </tt>
<a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line">    <tt class="py-comment">#----------------------public methods of the class-------------------------</tt> </tt>
<a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line">     </tt>
<a name="L38"></a><tt class="py-lineno">38</tt>  <tt class="py-line">     </tt>
<a name="Processor.calculate_indicators"></a><div id="Processor.calculate_indicators-def"><a name="L39"></a><tt class="py-lineno">39</tt> <a class="py-toggle" href="#" id="Processor.calculate_indicators-toggle" onclick="return toggle('Processor.calculate_indicators');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="src.processing.processor.Processor-class.html#calculate_indicators">calculate_indicators</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Processor.calculate_indicators-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="Processor.calculate_indicators-expanded"><a name="L40"></a><tt class="py-lineno">40</tt>  <tt class="py-line">        <tt class="py-docstring">'''</tt> </tt>
<a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line"><tt class="py-docstring">        calculates all indicators in the indicatorset.</tt> </tt>
<a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L43"></a><tt class="py-lineno">43</tt>  <tt class="py-line"><tt class="py-docstring">        @return: reference to the indicator-set containing the indicators</tt> </tt>
<a name="L44"></a><tt class="py-lineno">44</tt>  <tt class="py-line"><tt class="py-docstring">        '''</tt> </tt>
<a name="L45"></a><tt class="py-lineno">45</tt>  <tt class="py-line">         </tt>
<a name="L46"></a><tt class="py-lineno">46</tt>  <tt class="py-line">        <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt class="py-name">info</tt><tt class="py-op">(</tt><tt class="py-string">"Processor: start calculating the indicators"</tt><tt class="py-op">)</tt> </tt>
<a name="L47"></a><tt class="py-lineno">47</tt>  <tt class="py-line">         </tt>
<a name="L48"></a><tt class="py-lineno">48</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_indiset</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L49"></a><tt class="py-lineno">49</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_indiset</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Method src.processing.indicatorset.Indicatorset.build_indis()=src.processing.indicatorset.Indicatorset-class.html#build_indis"><a title="src.processing.indicatorset.Indicatorset.build_indis" class="py-name" href="#" onclick="return doclink('link-1', 'build_indis', 'link-1');">build_indis</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L50"></a><tt class="py-lineno">50</tt>  <tt class="py-line">             </tt>
<a name="L51"></a><tt class="py-lineno">51</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">indi</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_indiset</tt><tt class="py-op">:</tt>  </tt>
<a name="L52"></a><tt class="py-lineno">52</tt>  <tt class="py-line">                <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L53"></a><tt class="py-lineno">53</tt>  <tt class="py-line">                    <tt class="py-name">indi</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Method src.processing.buffer_index.Buffer_index.calculate()=src.processing.buffer_index.Buffer_index-class.html#calculate,Method src.processing.buffer_speed.Buffer_speed.calculate()=src.processing.buffer_speed.Buffer_speed-class.html#calculate,Method src.processing.buffer_speed_index.Buffer_speed_index.calculate()=src.processing.buffer_speed_index.Buffer_speed_index-class.html#calculate,Method src.processing.buffer_time.Buffer_time.calculate()=src.processing.buffer_time.Buffer_time-class.html#calculate,Method src.processing.correlation_coefficient.Correlation_coefficient.calculate()=src.processing.correlation_coefficient.Correlation_coefficient-class.html#calculate,Method src.processing.indicator.Indicator.calculate()=src.processing.indicator.Indicator-class.html#calculate,Method src.processing.mean_error.Mean_error.calculate()=src.processing.mean_error.Mean_error-class.html#calculate,Method src.processing.mean_squared_error.Mean_squared_error.calculate()=src.processing.mean_squared_error.Mean_squared_error-class.html#calculate,Method src.processing.network_completeness.Network_completeness.calculate()=src.processing.network_completeness.Network_completeness-class.html#calculate,Method src.processing.planning_speed_index.Planning_speed_index.calculate()=src.processing.planning_speed_index.Planning_speed_index-class.html#calculate,Method src.processing.planning_time.Planning_time.calculate()=src.processing.planning_time.Planning_time-class.html#calculate,Method src.processing.planning_time_index.Planning_time_index.calculate()=src.processing.planning_time_index.Planning_time_index-class.html#calculate,Method src.processing.total_correlation_coefficient.Total_correlation_coefficient.calculate()=src.processing.total_correlation_coefficient.Total_correlation_coefficient-class.html#calculate,Method src.processing.total_mean_error.Total_mean_error.calculate()=src.processing.total_mean_error.Total_mean_error-class.html#calculate,Method src.processing.total_mean_squared_error.Total_mean_squared_error.calculate()=src.processing.total_mean_squared_error.Total_mean_squared_error-class.html#calculate,Method src.processing.variation_speeds.Variation_speeds.calculate()=src.processing.variation_speeds.Variation_speeds-class.html#calculate"><a title="src.processing.buffer_index.Buffer_index.calculate
src.processing.buffer_speed.Buffer_speed.calculate
src.processing.buffer_speed_index.Buffer_speed_index.calculate
src.processing.buffer_time.Buffer_time.calculate
src.processing.correlation_coefficient.Correlation_coefficient.calculate
src.processing.indicator.Indicator.calculate
src.processing.mean_error.Mean_error.calculate
src.processing.mean_squared_error.Mean_squared_error.calculate
src.processing.network_completeness.Network_completeness.calculate
src.processing.planning_speed_index.Planning_speed_index.calculate
src.processing.planning_time.Planning_time.calculate
src.processing.planning_time_index.Planning_time_index.calculate
src.processing.total_correlation_coefficient.Total_correlation_coefficient.calculate
src.processing.total_mean_error.Total_mean_error.calculate
src.processing.total_mean_squared_error.Total_mean_squared_error.calculate
src.processing.variation_speeds.Variation_speeds.calculate" class="py-name" href="#" onclick="return doclink('link-2', 'calculate', 'link-2');">calculate</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L54"></a><tt class="py-lineno">54</tt>  <tt class="py-line">                <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> </tt>
<a name="L55"></a><tt class="py-lineno">55</tt>  <tt class="py-line">                    <tt class="py-name">logging</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Package src.error=src.error-module.html"><a title="src.error" class="py-name" href="#" onclick="return doclink('link-3', 'error', 'link-3');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">"Processor: cannot calculate the indicator "</tt> <tt class="py-op">+</tt> <tt class="py-name">indi</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Variable src.datastructure.link.Link.name=src.datastructure.link.Link-class.html#name,Variable src.datastructure.record_list.Record_list.name=src.datastructure.record_list.Record_list-class.html#name,Variable src.processing.indicator.Indicator.name=src.processing.indicator.Indicator-class.html#name"><a title="src.datastructure.link.Link.name
src.datastructure.record_list.Record_list.name
src.processing.indicator.Indicator.name" class="py-name" href="#" onclick="return doclink('link-4', 'name', 'link-4');">name</a></tt> <tt class="py-op">+</tt> <tt class="py-string">" because "</tt> <tt class="py-op">+</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method src.datastructure.agg_record.Agg_record.__str__()=src.datastructure.agg_record.Agg_record-class.html#__str__,Method src.datastructure.link.Link.__str__()=src.datastructure.link.Link-class.html#__str__,Method src.error.data_exceptions.Data_exception.__str__()=src.error.data_exceptions.Data_exception-class.html#__str__,Method src.error.exceptions.Config_exception.__str__()=src.error.exceptions.Config_exception-class.html#__str__,Method src.error.exceptions.Import_exception.__str__()=src.error.exceptions.Import_exception-class.html#__str__,Method src.error.exceptions.Indicator_exception.__str__()=src.error.exceptions.Indicator_exception-class.html#__str__,Method src.error.output_exceptions.Output_exception.__str__()=src.error.output_exceptions.Output_exception-class.html#__str__"><a title="src.datastructure.agg_record.Agg_record.__str__
src.datastructure.link.Link.__str__
src.error.data_exceptions.Data_exception.__str__
src.error.exceptions.Config_exception.__str__
src.error.exceptions.Import_exception.__str__
src.error.exceptions.Indicator_exception.__str__
src.error.output_exceptions.Output_exception.__str__" class="py-name" href="#" onclick="return doclink('link-5', '__str__', 'link-5');">__str__</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L56"></a><tt class="py-lineno">56</tt>  <tt class="py-line">             </tt>
<a name="L57"></a><tt class="py-lineno">57</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_indiset</tt> </tt>
</div></div><a name="L58"></a><tt class="py-lineno">58</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="src-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >ttrq4fleet - Petrina Papazek</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Oct 25 19:15:44 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
